is-builtin-module

What is is-builtin-module?

The is-builtin-module npm package is used to check if a given module name corresponds to a Node.js built-in module. This can be useful when developing tools that need to differentiate between built-in modules and third-party modules, such as bundlers, linters, or dependency analysis tools.

What are is-builtin-module's main functionalities?

Check if a module is a built-in module

This feature allows you to check if a given string corresponds to a Node.js built-in module. In the code sample, 'fs' is recognized as a built-in module, while 'express' is not.

const isBuiltinModule = require('is-builtin-module');

console.log(isBuiltinModule('fs')); // true
console.log(isBuiltinModule('express')); // false

Other packages similar to is-builtin-module

builtin-modules

The 'builtin-modules' package provides a list of the built-in modules of Node.js. It is similar to 'is-builtin-module' but instead of checking if a module is built-in, it provides the full list of built-in modules. You can use this list to check for built-in modules manually.

resolve

The 'resolve' package is a module resolution algorithm for Node.js, similar to the one used by 'require'. It can be used to check if a module is resolvable and, by extension, to infer if it is a built-in module. However, it is more general-purpose and not specifically designed for checking built-in modules.

README

is-builtin-module

Check if a string matches the name of a Node.js builtin module

Note that this matches based a static list of modules from the latest Node.js version. If you want to check for a module in the current Node.js, use the core isBuiltin method.

Install

npm install is-builtin-module

Usage

import isBuiltinModule from 'is-builtin-module';

isBuiltinModule('fs');
//=> true

isBuiltinModule('fs/promises');
//=> true

isBuiltinModule('node:fs/promises');
//=> true

isBuiltinModule('unicorn');
//=> false

Related

• builtin-modules - A static list of the Node.js builtin modules from the latest Node.js version